﻿///////////////////////////////////////////////////////////////////////////////
//
//  This source is part of the  "Managed Task Framework.NET Runtime"  (MTF.NET Runtime).
//
//
//  Copyright (c) 2011, Multicore Consulting Limited (UK)
//  All rights reserved.
//  http://www.multicoreconsulting.co.uk
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  -  Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  -  Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in
//     the documentation and/or other materials provided with the
//     distribution.
//  -  Neither the name of Multicore Consulting Limited nor the names of
//     its contributors may be used to endorse or promote products
//     derived from this software without specific prior written
//     permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
//  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
//  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
//  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
//  COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
//  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
//  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
//  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
//  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
//  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//
///////////////////////////////////////////////////////////////////////////////

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace MTFOrg.MTF.MTFRuntime
{
    public interface ITask
    {
        /// <summary>
        /// Task name
        /// </summary>
        string Name
        {
            get;
        }

        /// <summary>
        /// Gets the dimensions of this task.
        /// </summary>
        int[] Dimensions
        {
            get;
        }

        /// <summary>
        /// Full path from root task to this task.
        /// </summary>
        string FullPath
        {
            get;
        }

        /// <summary>
        /// Gets the task manager
        /// </summary>
        ITaskManager TaskManager
        {
            get;
        }

        /// <summary>
        /// Returns the parent task of this task
        /// </summary>
        ITask ParentTask
        {
            get;
        }

        /// <summary>
        /// Processes an incoming event and invokes the appropriate event handler
        /// </summary>
        /// <param name="eventArgs">Event arguments</param>
        void ProcessEvent(object eventArgs);

        /// <summary>
        /// Called to initialize this task.
        /// </summary>
        void OnInitialize();

        /// <summary>
        /// Invoked to request start of application execution
        /// </summary>
        void OnBeginExecution();

        /// <summary>
        /// Invoked to shut down application
        /// </summary>
        void OnEndExecution();

        /// <summary>
        /// Call to start up the top-level task.
        /// </summary>
        void Startup();

        /// <summary>
        /// Gets the property with the specified name.
        /// </summary>
        /// <param name="name">Name of property to return</param>
        /// <returns>Property object with specified name</returns>
        object GetProperty(string name);
    }
}
